Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(patterns): Adds actions pattern. #4086

Merged
merged 16 commits into from
Jul 31, 2024
Merged

Conversation

edonehoo
Copy link
Collaborator

Closes #3986

@edonehoo edonehoo self-assigned this Jun 11, 2024
@patternfly-build
Copy link
Contributor

patternfly-build commented Jun 11, 2024

@edonehoo edonehoo requested a review from mmenestr June 11, 2024 14:09
@edonehoo
Copy link
Collaborator Author

@mmenestr can you lmk what you think about this draft when you get a sec! I'm not sure how I feel about the info organization -- it felt a little awkward, but I also didn't really like any of the rearrangements I tried. So curious for thoughts/feedback in general!

@mmenestr
Copy link
Collaborator

I think the organization is fine if that's all that's gonna be in there! I think this page would also be good for things like "how to deal with actions" ie: what they trigger - do they trigger a modal? Does the action happen immediately? Which I think was an issue that Pankaj was working on which I reassigned to you, if I remember correctly (?)

So for example, "Deletion" actions. This would be a good place to specify that destructive actions should be red and that clicking on a delete button should always pop-up a modal before actually deleting the thing. So in that sense it belongs more in the "Pattern" page because you're explaining a pattern that should be followed of Clicking on a delete button --> Showing a modal --> And then actually deleting the item (as opposed to clicking delete immediately deleting the thing).

And you can go further by comparing it to a "Remove" action which wouldn't necessarily require a red button (or even a modal potentially) because it's something that can easily be recovered.

@mmenestr
Copy link
Collaborator

Also - I noticed you used purple little number markers instead of the usual pink. If that's not something you're going to change across every image, I would keep to the classic pink we usually use!

@edonehoo
Copy link
Collaborator Author

@mmenestr oo yes tysm for the ideas on how to expand! I did still have that other issue in my backlog and forgot to include it -- will expand to add all that 🤘

@edonehoo
Copy link
Collaborator Author

@mmenestr pushed some updates here! I added deletion info from that other issue, and also from looking around on uxd hub (so I may have grabbed some opinionated info). Lmk if the guidance I added rings true from your perspective 👀

Copy link
Collaborator

@mmenestr mmenestr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left a couple comments but looks great so far!!

@edonehoo edonehoo linked an issue Jul 11, 2024 that may be closed by this pull request
![Inline success alert for deletion.](./img/critical-deletion-success.png)

#### Removal
When the action of deleting a resource can be reversed, it has a lower impact on the user experience. A confirmation dialog isn't necessary because users can easily retrieve the deleted resource.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just need to update text in body to match the title - so instead of saying "action of deleting", would write "action of removing"

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah yes, good catch ty!

Copy link
Collaborator

@mmenestr mmenestr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just have one small comment otherwise looks good

![Inline success alert for deletion.](./img/critical-deletion-success.png)

#### Removal
When the action of removing a resource can be reversed, it has a lower impact on the user experience. A confirmation dialog isn't necessary because users can easily retrieve the deleted resource.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

there's another "delete" later in the paragraph to edit 😀

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oml 😅 let me push that too. Thanks for bearing with me!

@edonehoo edonehoo requested a review from nicolethoen July 29, 2024 13:52
@edonehoo
Copy link
Collaborator Author

@nicolethoen I think we can merge this!

@nicolethoen nicolethoen merged commit c71ccf0 into patternfly:main Jul 31, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

New guideline - Actions - Patterns [Patterns] - Add guidelines around deletion
4 participants